<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: Initialization and Basic Functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__adcmic__functions__basic.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Initialization and Basic Functions<div class="ingroups"><a class="el" href="group__group__adcmic.html">ADCMic       (Delta-Sigma ADC with PDM microphone support)</a> &raquo; <a class="el" href="group__group__adcmic__functions.html">Functions</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<p>This set of functions is for initialization and basic usage. </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga3a8b909addc754b68cd7373e63f1fdbc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__adcmic__enums.html#gaf46b38a86a6fbdfee98d9b37ae44a154">cy_en_adcmic_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__adcmic__functions__basic.html#ga3a8b909addc754b68cd7373e63f1fdbc">Cy_ADCMic_Init</a> (<a class="el" href="struct_m_x_s40_a_d_c_m_i_c___type.html">MXS40ADCMIC_Type</a> *base, <a class="el" href="structcy__stc__adcmic__config__t.html">cy_stc_adcmic_config_t</a> const *config, <a class="el" href="group__group__adcmic__enums.html#ga0c6998d15b030e746482c263d62569c4">cy_en_adcmic_mode_t</a> <a class="el" href="group__group__ipc__bt__data__structures.html#ga37e90f5e3bd99fac2021fb3a326607d4">mode</a>)</td></tr>
<tr class="memdesc:ga3a8b909addc754b68cd7373e63f1fdbc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the ADCMic block from a pre-initialized configuration structure.  <a href="#ga3a8b909addc754b68cd7373e63f1fdbc">More...</a><br /></td></tr>
<tr class="separator:ga3a8b909addc754b68cd7373e63f1fdbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8a1feaca602d505d6faea844e1450593"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__adcmic__functions__basic.html#ga8a1feaca602d505d6faea844e1450593">Cy_ADCMic_InitBiquad</a> (<a class="el" href="struct_m_x_s40_a_d_c_m_i_c___type.html">MXS40ADCMIC_Type</a> *base, <a class="el" href="structcy__stc__adcmic__biquad__config__t.html">cy_stc_adcmic_biquad_config_t</a> const *biQuadConfig)</td></tr>
<tr class="memdesc:ga8a1feaca602d505d6faea844e1450593"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the biquad filter coefficients.  <a href="#ga8a1feaca602d505d6faea844e1450593">More...</a><br /></td></tr>
<tr class="separator:ga8a1feaca602d505d6faea844e1450593"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadd0e574dab13e1e437c946c399ca9edb"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__adcmic__functions__basic.html#gadd0e574dab13e1e437c946c399ca9edb">Cy_ADCMic_BiquadBypass</a> (<a class="el" href="struct_m_x_s40_a_d_c_m_i_c___type.html">MXS40ADCMIC_Type</a> *base, bool bypass)</td></tr>
<tr class="memdesc:gadd0e574dab13e1e437c946c399ca9edb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bypasses/unbypasses the biquad filter.  <a href="#gadd0e574dab13e1e437c946c399ca9edb">More...</a><br /></td></tr>
<tr class="separator:gadd0e574dab13e1e437c946c399ca9edb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga722d964ea6930fcd47b8e02b329669ea"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__adcmic__functions__basic.html#ga722d964ea6930fcd47b8e02b329669ea">Cy_ADCMic_Enable</a> (<a class="el" href="struct_m_x_s40_a_d_c_m_i_c___type.html">MXS40ADCMIC_Type</a> *base)</td></tr>
<tr class="memdesc:ga722d964ea6930fcd47b8e02b329669ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables the ADCMic block operation.  <a href="#ga722d964ea6930fcd47b8e02b329669ea">More...</a><br /></td></tr>
<tr class="separator:ga722d964ea6930fcd47b8e02b329669ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga70979a0967644dec401b37a2a29b2481"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__adcmic__functions__basic.html#ga70979a0967644dec401b37a2a29b2481">Cy_ADCMic_Disable</a> (<a class="el" href="struct_m_x_s40_a_d_c_m_i_c___type.html">MXS40ADCMIC_Type</a> *base)</td></tr>
<tr class="memdesc:ga70979a0967644dec401b37a2a29b2481"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disables the ADCMic block operation.  <a href="#ga70979a0967644dec401b37a2a29b2481">More...</a><br /></td></tr>
<tr class="separator:ga70979a0967644dec401b37a2a29b2481"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga76a424f92c974d8373b1c9dd75ee2e77"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__adcmic__enums.html#gaf46b38a86a6fbdfee98d9b37ae44a154">cy_en_adcmic_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__adcmic__functions__basic.html#ga76a424f92c974d8373b1c9dd75ee2e77">Cy_ADCMic_SetSampleRate</a> (<a class="el" href="struct_m_x_s40_a_d_c_m_i_c___type.html">MXS40ADCMIC_Type</a> *base, <a class="el" href="group__group__adcmic__enums.html#ga60be2d6103fee3f7a1dbb0f7732ecb16">cy_en_adcmic_sample_rate_t</a> sampleRate)</td></tr>
<tr class="memdesc:ga76a424f92c974d8373b1c9dd75ee2e77"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the specified ADC sample rate.  <a href="#ga76a424f92c974d8373b1c9dd75ee2e77">More...</a><br /></td></tr>
<tr class="separator:ga76a424f92c974d8373b1c9dd75ee2e77"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7a7ebf8b2e9e1f0da08aeb4636664d8a"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__adcmic__functions__basic.html#ga7a7ebf8b2e9e1f0da08aeb4636664d8a">Cy_ADCMic_ClearTrigger</a> (<a class="el" href="struct_m_x_s40_a_d_c_m_i_c___type.html">MXS40ADCMIC_Type</a> *base, uint32_t trigMask)</td></tr>
<tr class="memdesc:ga7a7ebf8b2e9e1f0da08aeb4636664d8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears the specified trigger signal.  <a href="#ga7a7ebf8b2e9e1f0da08aeb4636664d8a">More...</a><br /></td></tr>
<tr class="separator:ga7a7ebf8b2e9e1f0da08aeb4636664d8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga3a8b909addc754b68cd7373e63f1fdbc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3a8b909addc754b68cd7373e63f1fdbc">&#9670;&nbsp;</a></span>Cy_ADCMic_Init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__adcmic__enums.html#gaf46b38a86a6fbdfee98d9b37ae44a154">cy_en_adcmic_status_t</a> Cy_ADCMic_Init </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_m_x_s40_a_d_c_m_i_c___type.html">MXS40ADCMIC_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__adcmic__config__t.html">cy_stc_adcmic_config_t</a> const *&#160;</td>
          <td class="paramname"><em>config</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__adcmic__enums.html#ga0c6998d15b030e746482c263d62569c4">cy_en_adcmic_mode_t</a>&#160;</td>
          <td class="paramname"><em>mode</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initializes the ADCMic block from a pre-initialized configuration structure. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the hardware ADCMic block.</td></tr>
    <tr><td class="paramname">config</td><td>The pointer to the configuration structure <a class="el" href="structcy__stc__adcmic__config__t.html">cy_stc_adcmic_config_t</a>.</td></tr>
    <tr><td class="paramname">mode</td><td>The ADCMic operation mode /ref cy_en_adcmic_mode_t.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The status <a class="el" href="group__group__adcmic__enums.html#gaf46b38a86a6fbdfee98d9b37ae44a154">cy_en_adcmic_status_t</a>.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: Initialize ADCMic for the analog microphone operation: */</span></div><div class="line">    <span class="keywordflow">if</span> (<a class="code" href="group__group__adcmic__enums.html#ggaf46b38a86a6fbdfee98d9b37ae44a154a5372a55427aca75e12013c2bb7844157">CY_ADCMIC_SUCCESS</a> != <a class="code" href="group__group__adcmic__functions__basic.html#ga3a8b909addc754b68cd7373e63f1fdbc">Cy_ADCMic_Init</a>(MXS40ADCMIC0, &amp;config, <a class="code" href="group__group__adcmic__enums.html#gga0c6998d15b030e746482c263d62569c4aa0919e8b8af8bc814cd0c65eae6fd34d">CY_ADCMIC_MIC</a>))</div><div class="line">    {</div><div class="line">        <span class="comment">/* Something went wrong, insert error handling here */</span></div><div class="line">    }</div><div class="line"></div><div class="line">    <span class="keywordflow">if</span> (<a class="code" href="group__group__adcmic__enums.html#ggaf46b38a86a6fbdfee98d9b37ae44a154a5372a55427aca75e12013c2bb7844157">CY_ADCMIC_SUCCESS</a> != <a class="code" href="group__group__adcmic__functions__basic.html#ga76a424f92c974d8373b1c9dd75ee2e77">Cy_ADCMic_SetSampleRate</a>(MXS40ADCMIC0, <a class="code" href="group__group__adcmic__enums.html#gga60be2d6103fee3f7a1dbb0f7732ecb16a66ba39acdbc0f0925fb6c67e700448c3">CY_ADCMIC_16KSPS</a>))</div><div class="line">    {</div><div class="line">        <span class="comment">/* Something went wrong, insert error handling here */</span></div><div class="line">    }</div><div class="line"></div><div class="line">    <a class="code" href="group__group__adcmic__functions__basic.html#ga722d964ea6930fcd47b8e02b329669ea">Cy_ADCMic_Enable</a>(MXS40ADCMIC0); <span class="comment">/* Enable the block operation */</span></div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="ga8a1feaca602d505d6faea844e1450593"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8a1feaca602d505d6faea844e1450593">&#9670;&nbsp;</a></span>Cy_ADCMic_InitBiquad()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_ADCMic_InitBiquad </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_m_x_s40_a_d_c_m_i_c___type.html">MXS40ADCMIC_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__adcmic__biquad__config__t.html">cy_stc_adcmic_biquad_config_t</a> const *&#160;</td>
          <td class="paramname"><em>biQuadConfig</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initializes the biquad filter coefficients. </p>
<p>Usually is called from the <a class="el" href="group__group__adcmic__functions__basic.html#ga3a8b909addc754b68cd7373e63f1fdbc">Cy_ADCMic_Init</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the hardware ADCMic block.</td></tr>
    <tr><td class="paramname">biQuadConfig</td><td>The pointer to the biquad filter configuration structure <a class="el" href="structcy__stc__adcmic__biquad__config__t.html">cy_stc_adcmic_biquad_config_t</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: Initialize entire ADCMic with biquad filter */</span></div><div class="line">    config.micConfig-&gt;biQuadConfig = &amp;biquadCfg;</div><div class="line">    <span class="keywordflow">if</span> (<a class="code" href="group__group__adcmic__enums.html#ggaf46b38a86a6fbdfee98d9b37ae44a154a5372a55427aca75e12013c2bb7844157">CY_ADCMIC_SUCCESS</a> != <a class="code" href="group__group__adcmic__functions__basic.html#ga3a8b909addc754b68cd7373e63f1fdbc">Cy_ADCMic_Init</a>(MXS40ADCMIC0, &amp;config, <a class="code" href="group__group__adcmic__enums.html#gga0c6998d15b030e746482c263d62569c4aa0919e8b8af8bc814cd0c65eae6fd34d">CY_ADCMIC_MIC</a>))</div><div class="line">    {</div><div class="line">        <span class="comment">/* Something went wrong, insert error handling here */</span></div><div class="line">    }</div><div class="line"></div><div class="line">    <span class="comment">/* or initialize the BiQuad filter separately */</span></div><div class="line">    <a class="code" href="group__group__adcmic__functions__basic.html#ga8a1feaca602d505d6faea844e1450593">Cy_ADCMic_InitBiquad</a>(MXS40ADCMIC0, &amp;biquadCfg);</div><div class="line">    <a class="code" href="group__group__adcmic__functions__basic.html#gadd0e574dab13e1e437c946c399ca9edb">Cy_ADCMic_BiquadBypass</a>(MXS40ADCMIC0, <span class="keyword">false</span>); <span class="comment">/* Unbypass the biquad filter */</span></div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="gadd0e574dab13e1e437c946c399ca9edb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadd0e574dab13e1e437c946c399ca9edb">&#9670;&nbsp;</a></span>Cy_ADCMic_BiquadBypass()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_ADCMic_BiquadBypass </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_m_x_s40_a_d_c_m_i_c___type.html">MXS40ADCMIC_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>bypass</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Bypasses/unbypasses the biquad filter. </p>
<p>Usually is called from the <a class="el" href="group__group__adcmic__functions__basic.html#ga3a8b909addc754b68cd7373e63f1fdbc">Cy_ADCMic_Init</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the hardware ADCMic block.</td></tr>
    <tr><td class="paramname">bypass</td><td>The boolean specifier to bypass(true) or unbypass(false) the biquad filter. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga722d964ea6930fcd47b8e02b329669ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga722d964ea6930fcd47b8e02b329669ea">&#9670;&nbsp;</a></span>Cy_ADCMic_Enable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_ADCMic_Enable </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_m_x_s40_a_d_c_m_i_c___type.html">MXS40ADCMIC_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enables the ADCMic block operation. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the hardware ADCMic block.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: Initialize ADCMic for the analog microphone operation: */</span></div><div class="line">    <span class="keywordflow">if</span> (<a class="code" href="group__group__adcmic__enums.html#ggaf46b38a86a6fbdfee98d9b37ae44a154a5372a55427aca75e12013c2bb7844157">CY_ADCMIC_SUCCESS</a> != <a class="code" href="group__group__adcmic__functions__basic.html#ga3a8b909addc754b68cd7373e63f1fdbc">Cy_ADCMic_Init</a>(MXS40ADCMIC0, &amp;config, <a class="code" href="group__group__adcmic__enums.html#gga0c6998d15b030e746482c263d62569c4aa0919e8b8af8bc814cd0c65eae6fd34d">CY_ADCMIC_MIC</a>))</div><div class="line">    {</div><div class="line">        <span class="comment">/* Something went wrong, insert error handling here */</span></div><div class="line">    }</div><div class="line"></div><div class="line">    <span class="keywordflow">if</span> (<a class="code" href="group__group__adcmic__enums.html#ggaf46b38a86a6fbdfee98d9b37ae44a154a5372a55427aca75e12013c2bb7844157">CY_ADCMIC_SUCCESS</a> != <a class="code" href="group__group__adcmic__functions__basic.html#ga76a424f92c974d8373b1c9dd75ee2e77">Cy_ADCMic_SetSampleRate</a>(MXS40ADCMIC0, <a class="code" href="group__group__adcmic__enums.html#gga60be2d6103fee3f7a1dbb0f7732ecb16a66ba39acdbc0f0925fb6c67e700448c3">CY_ADCMIC_16KSPS</a>))</div><div class="line">    {</div><div class="line">        <span class="comment">/* Something went wrong, insert error handling here */</span></div><div class="line">    }</div><div class="line"></div><div class="line">    <a class="code" href="group__group__adcmic__functions__basic.html#ga722d964ea6930fcd47b8e02b329669ea">Cy_ADCMic_Enable</a>(MXS40ADCMIC0); <span class="comment">/* Enable the block operation */</span></div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="ga70979a0967644dec401b37a2a29b2481"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga70979a0967644dec401b37a2a29b2481">&#9670;&nbsp;</a></span>Cy_ADCMic_Disable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_ADCMic_Disable </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_m_x_s40_a_d_c_m_i_c___type.html">MXS40ADCMIC_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Disables the ADCMic block operation. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the hardware ADCMic block.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: The ADCMic block is not needed more: */</span></div><div class="line">    <a class="code" href="group__group__adcmic__functions__basic.html#ga70979a0967644dec401b37a2a29b2481">Cy_ADCMic_Disable</a>(MXS40ADCMIC0); <span class="comment">/* Disable the block operation */</span></div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="ga76a424f92c974d8373b1c9dd75ee2e77"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga76a424f92c974d8373b1c9dd75ee2e77">&#9670;&nbsp;</a></span>Cy_ADCMic_SetSampleRate()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__adcmic__enums.html#gaf46b38a86a6fbdfee98d9b37ae44a154">cy_en_adcmic_status_t</a> Cy_ADCMic_SetSampleRate </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_m_x_s40_a_d_c_m_i_c___type.html">MXS40ADCMIC_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__adcmic__enums.html#ga60be2d6103fee3f7a1dbb0f7732ecb16">cy_en_adcmic_sample_rate_t</a>&#160;</td>
          <td class="paramname"><em>sampleRate</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the specified ADC sample rate. </p>
<p>Applicable for MIC/PDM modes only.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the hardware ADCMic block.</td></tr>
    <tr><td class="paramname">sampleRate</td><td>The source value <a class="el" href="group__group__adcmic__enums.html#ga60be2d6103fee3f7a1dbb0f7732ecb16">cy_en_adcmic_sample_rate_t</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The status <a class="el" href="group__group__adcmic__enums.html#gaf46b38a86a6fbdfee98d9b37ae44a154">cy_en_adcmic_status_t</a>.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: Initialize ADCMic for the analog microphone operation: */</span></div><div class="line">    <span class="keywordflow">if</span> (<a class="code" href="group__group__adcmic__enums.html#ggaf46b38a86a6fbdfee98d9b37ae44a154a5372a55427aca75e12013c2bb7844157">CY_ADCMIC_SUCCESS</a> != <a class="code" href="group__group__adcmic__functions__basic.html#ga3a8b909addc754b68cd7373e63f1fdbc">Cy_ADCMic_Init</a>(MXS40ADCMIC0, &amp;config, <a class="code" href="group__group__adcmic__enums.html#gga0c6998d15b030e746482c263d62569c4aa0919e8b8af8bc814cd0c65eae6fd34d">CY_ADCMIC_MIC</a>))</div><div class="line">    {</div><div class="line">        <span class="comment">/* Something went wrong, insert error handling here */</span></div><div class="line">    }</div><div class="line"></div><div class="line">    <span class="keywordflow">if</span> (<a class="code" href="group__group__adcmic__enums.html#ggaf46b38a86a6fbdfee98d9b37ae44a154a5372a55427aca75e12013c2bb7844157">CY_ADCMIC_SUCCESS</a> != <a class="code" href="group__group__adcmic__functions__basic.html#ga76a424f92c974d8373b1c9dd75ee2e77">Cy_ADCMic_SetSampleRate</a>(MXS40ADCMIC0, <a class="code" href="group__group__adcmic__enums.html#gga60be2d6103fee3f7a1dbb0f7732ecb16a66ba39acdbc0f0925fb6c67e700448c3">CY_ADCMIC_16KSPS</a>))</div><div class="line">    {</div><div class="line">        <span class="comment">/* Something went wrong, insert error handling here */</span></div><div class="line">    }</div><div class="line"></div><div class="line">    <a class="code" href="group__group__adcmic__functions__basic.html#ga722d964ea6930fcd47b8e02b329669ea">Cy_ADCMic_Enable</a>(MXS40ADCMIC0); <span class="comment">/* Enable the block operation */</span></div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="ga7a7ebf8b2e9e1f0da08aeb4636664d8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7a7ebf8b2e9e1f0da08aeb4636664d8a">&#9670;&nbsp;</a></span>Cy_ADCMic_ClearTrigger()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_ADCMic_ClearTrigger </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_m_x_s40_a_d_c_m_i_c___type.html">MXS40ADCMIC_Type</a> *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>trigMask</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Clears the specified trigger signal. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the hardware ADC block.</td></tr>
    <tr><td class="paramname">trigMask</td><td>The mask of triggers to clear. Select one or more masks from <a class="el" href="group__group__adcmic__macros__triggers.html">Triggers</a> and "OR" them together:<ul>
<li><a class="el" href="group__group__adcmic__macros__triggers.html#gae112d71129c8129bb2ab0b156e38eb36">CY_ADCMIC_TRIG_DC</a></li>
<li><a class="el" href="group__group__adcmic__macros__triggers.html#gadc44090d956c7a21e0da9986894430bb">CY_ADCMIC_TRIG_DATA</a> </li>
</ul>
</td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
